package com.ais.gaea.annotation;

import com.ais.gaea.ColumnType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author xuning
 * @date 2022/11/26 13:42
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TableColumn {
    /**
     * 字段名称
     */
    String name();

    /**
     * 字段类型
     */
    ColumnType type();

    /**
     * 是否是主键，仅当主键是一列，若为多列，使用{@link TableConstraint}主键约束来创建主键
     */
    boolean primaryKey() default false;

    /**
     * 变长字符的大小
     */
    int length() default 0;

    /**
     * 精度大小
     */
    int precision() default 10;

    /**
     * 标度大小
     */
    int scale() default 0;

    /**
     * 字段是否允许为空，默认为true
     */
    boolean nullable() default true;

    /**
     * 字段默认的值,默认没有默认值
     */
    String defaultValue() default "";

    /**
     * 字段描述信息
     */
    String comment() default "";
}
